IMotion.SetAxisTouchProbe method

Records the position of an axis at a trigger event.

Namespace: IntervalZero.KINGSTAR.Base.Api

Assembly: IntervalZero.KINGSTAR.Base.Api (in IntervalZero.KINGSTAR.Base.dll) Version: 4.4.0.0

Syntax

KsCommandStatus<double> SetAxisTouchProbe(
       int Index,
       McProbeTrigger TriggerInput,
       bool WindowOnly,
       double firstPosition,
       double lastPosition
)

Function SetAxisTouchProbe(
       Index As Integer,
       TriggerInput As McProbeTrigger,
       WindowOnly As Boolean,
       firstPosition As Double,
       lastPosition As Double
) As KsCommandStatus(Of Double)

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

TriggerInput [in]

Type: McProbeTrigger

The trigger signal source. Trigger input may be specified by the Index.

WindowOnly [in]

Type: bool

If set, only the value in the window will be used to trigger events. The window is the range between firstPosition and lastPosition.

firstPosition [in]

Type: double

The start position from where (positive direction) trigger events are accepted (in user units). The value included in window. Currently, firstPosition must be less than lastPosition.

lastPosition [in]

Type: double

The end position of the window (in user units). The value included in window.

Return value

Type: KsCommandStatus<double>

Returns a state of a method and a double value.

Remarks

To use this method, touch probe must be enabled using IApi.EnableTouchProbe.
One method instance should represent exactly one probing command.
In case of multiple instances on the same probe and axis, the elements of McProbeTrigger should be extended with TouchProbeId, the identification of a unique probing command, which can be linked to IApi.AbortCommand.
After SetAxisTouchProbe is done, you need to wait one cycle for the touch probe to take effect.
For further details about how touch probe works, see Concepts > Touch probe
When modulo axis is enabled, the modulo value will be applied to the firstPosition and lastPosition parameters, and the output value in the returned command status.

Examples

N/A